home *** CD-ROM | disk | FTP | other *** search
/ Magnum One / Magnum One (Mid-American Digital) (Disc Manufacturing).iso / d19 / fdc_310.arc / FDC-310.DOC < prev    next >
Text File  |  1991-07-01  |  21KB  |  502 lines
  1.  
  2.                         ┌─────────────────────────┐
  3.                         │  FILE DOWNLOAD COUNTER  │
  4.                         └─────────────────────────┘
  5.                       
  6.                               Version 3.10
  7.  
  8.                               June 30, 1991
  9.  
  10.                             ─────────────────
  11.                             USER FEE REQUIRED
  12.                             ─────────────────
  13.  
  14.                                Written by:
  15.                            Brandon M. Bachman
  16.  
  17.                              Distributed By:
  18.                             The Salt City BBS
  19.  
  20.                       (801) 292-3308 (HST V.42Bis)
  21.  
  22.                        PCRelay routable-> TERMINAL
  23.                            FidoNet (1:311/7)
  24.  
  25.  
  26.       Copyright (C) 1990-91 by Brandon M. Bachman.  All Rights Reserved.
  27.  
  28.  
  29.  
  30.  
  31.  
  32. ┌───────────────────┐
  33. │ TABLE OF CONTENTS │
  34. └───────────────────┴──────────────────────────────────────────────────────
  35.  
  36.            ┌─────────┐
  37.            │ General │
  38.            └─────────┘
  39.            Overview ..................................... 1-1
  40.            Program Features ............................. 1-2
  41.            Registrered and Unregistered Versions ........ 1-3
  42.            Why Should I Register? ....................... 1-4
  43.            Disclaimer ................................... 1-5
  44.            License ...................................... 1-6
  45.            System Requirements .......................... 1-7
  46.            Files in the FDC Archive ..................... 1-8
  47.  
  48.            ┌──────┐
  49.            │ How? │
  50.            └──────┘
  51.            How FDC Operates ............................. 2-1
  52.            Installation ................................. 2-2
  53.            A Configuration File ......................... 2-3
  54.            Starting New with FDC ........................ 2-4
  55.            Removing FDC Entries ......................... 2-5
  56.            Log File ..................................... 2-6
  57.            Word Wrapping ................................ 2-7
  58.            Formats For Recording Download Count ......... 2-8
  59.  
  60.            ┌───────────────┐
  61.            │ Configuration │
  62.            └───────────────┘
  63.            The Configuration File ....................... 4-1
  64.            Sample Configuration File .................... 4-2
  65.  
  66.            ┌──────┐
  67.            │ Why? │
  68.            └──────┘
  69.            Operational Details .......................... 5-1
  70.            Examples of Command Line Arguments ........... 5-2
  71.            Common Questions and Answers ................. 5-3
  72.  
  73.            ┌───────┐
  74.            │ What? │
  75.            └───────┘
  76.            Technical Support ............................ 6-1
  77.            Other Programs by Brandon M. Bachman ......... 6-2
  78.  
  79.  
  80.  
  81. ┌──────────┐
  82. │ OVERVIEW │                                                          1-1
  83. └──────────┴─────────────────────────────────────────────────────────────
  84. FDC will edit the descriptions in PCBoard's DIR files with a <#>, where #
  85. is the number of times the file has been downloaded from your BBS.
  86.  
  87. FDC makes it easy for you and your users to see instantly which files are
  88. the most popular, and give you an idea of what software you should keep
  89. online and which programs are "dead wood" to be removed.
  90.  
  91. FDC will also create custom bulletins to help you determine the over all
  92. most popular downloads on your BBS.
  93.  
  94.  
  95.  
  96. PROGRAM FEATURES                                                       1-2
  97. ──────────────────────────────────────────────────────────────────────────
  98. ■ Automatically finds new downloads since the last date FDC was run.
  99.  
  100. ■ Reads any size (extremely large) DOWNLOAD.TXT files.
  101.  
  102. ■ Creates a 'customizable' bulletin of the most popular files. (FDC-BLT)
  103.  
  104. ■ Counts as many as <2,000,000,000> downloads of a single file!.
  105.  
  106. ■ Auto word wraps the description lines to *any* column you would like
  107.   leaving the "Uploaded by:" line undisturbed with word wrapping.
  108.  
  109. ■ Log file output (in PCBoard format) to monitor the program.
  110.  
  111. ■ Will run smoothly in your nightly event.
  112.  
  113. ■ Popular with users and SysOps as a guide to good programs.
  114.  
  115. ■ Supports entries made from Bimodem in your DOWNLOAD.TXT file.
  116.  
  117. ■ Creates a database of all un-processed files to re-try on future runs
  118.   therefore making the count 100% accurate.
  119.  
  120. ■ Written in Turbo C++ for fast compact code.
  121.  
  122. ■ Creates a summary bullein of the top downloads.
  123.  
  124. ■ And much more!  Read On!
  125.  
  126.  
  127.  
  128. REGISTERED AND UNREGISTERED VERSIONS                                   1-3
  129. ──────────────────────────────────────────────────────────────────────────
  130. "File Download Counter" is not Public Domain or Free ware.  Unregistered
  131. versions are 21 day evaluation copies only, after which they should either
  132. be destroyed or a license agreement purchased.  It's only $15 so please
  133. register your copy today.  Read 'REGISTER.TXT' included with this archive
  134. for more information.
  135.  
  136.  
  137.  
  138. WHY SHOULD I REGISTER?                                                 1-4
  139. ──────────────────────────────────────────────────────────────────────────
  140. ■ FDC will count beyond the 25 download count limit if registered.
  141.  
  142. ■ Free technical support via the Salt City Bulletin Board.
  143.  
  144. ■ Lifetime free updates of all future versions guaranteed.
  145.  
  146. ■ Help support future updates and development of FDC.
  147.  
  148. ■ Support the shareware concept.
  149.  
  150.  
  151.  
  152. DISCLAIMER                                                             1-5
  153. ──────────────────────────────────────────────────────────────────────────
  154. The authors make no warranties or representation of any kind, expressed or
  155. implied, with respect to "File Download Counter", or its quality,
  156. reliability, or performance, or its merchantability or fitness for any
  157. purpose.  The user assumes the entire risk as to the quality, performance
  158. and reliability of the software and documentation.
  159.  
  160.  
  161.  
  162. LICENSE                                                                1-6
  163. ──────────────────────────────────────────────────────────────────────────
  164. The "File Download Counter" ("The Software") is COPYRIGHT 1990-91 by
  165. Brandon M. Bachman, ALL RIGHTS RESERVED WORLDWIDE.
  166.  
  167. A license grants you a nonexclusive, nontransferable license to use
  168. "File Download Counter" software on a single central processing unit at any
  169. one time.  Site licenses are available upon request for Networks exceeding
  170. 3 remote nodes.
  171.  
  172. You may NOT engage in, nor permit third parties to engage in, any of the
  173. following :
  174.  
  175.         A)  Sell, rent, sub-license, lease, or grant other rights
  176.             of this software to others.
  177.  
  178.         B)  Attempt to disassemble, decompile, or reverse engineer
  179.             the software or the files it generates in any way.
  180.  
  181.         C)  Make alterations of any kind in the files of this
  182.             software, except as noted below.
  183.  
  184.         D)  Collect fees for distribution of the software.
  185.  
  186. The authors of the software grant you a license to use this software as
  187. long as you meet the above conditions.  Any violation of the above
  188. conditions will result in the termination of your license to use this
  189. software.  Upon termination of this license for any reason, you must
  190. stop using the software and destroy all copies of it in your possession
  191. immediately.
  192.  
  193. The author(s) of this software are not liable for damages suffered as a
  194. result of the improper use, proper use, or inability to use this
  195. software.  This type of disclaimer is prohibited by law in some states,
  196. and is therefore void in those states.
  197.  
  198.  
  199.  
  200. SYSTEM REQUIREMENTS                                                    1-7
  201. ──────────────────────────────────────────────────────────────────────────
  202. To run "File Download Counter" you will need the following:
  203.  
  204. 1.  IBM PC/XT/AT, PS/2 or 100% compatible machine.
  205. 2.  Color or Monochrome Graphics adapter.
  206. 3.  MS-DOS 3.0 or higher.
  207. 4.  PCBoard BBS Software.
  208.  
  209.  
  210.  
  211. FILES IN THIS ARCHIVE                                                  1-8
  212. ──────────────────────────────────────────────────────────────────────────
  213. "File Download Counter" is distributed as a archival file "FDC-XXX.ZIP"
  214. You must have PkZip v1.10 or later to extract the files listed below.
  215. PkZip v1.10 is Shareware and is available on many computer bulletin boards.
  216. Files in the archive include:
  217.  
  218.        FDC.EXE      -  The "File Download Counter" program.
  219.        SAMPLE.CFG   -  Sample configuration file.
  220.        FDC-310.DOC  -  This documentation file.
  221.        HISTORY.DOC  -  List of improvements to FDC, and history.
  222.        REGISTER.DOC -  Information on registering your copy.
  223.        README.DOC   -  Important information for new and old users.
  224.        USERS.DOC    -  List of registered users.
  225.        COMMENTS.DOC -  List of comments from other users of FDC.
  226.  
  227. Sysops are free to distribute uregistered versions of FDC as a complete
  228. unaltered archive only.
  229.  
  230.  
  231.  
  232. HOW FDC OPERATES                                                       2-1
  233. ──────────────────────────────────────────────────────────────────────────
  234. FDC will read the DOWNLOAD.TXT file created by PCBoard, and count all
  235. recently downloaded files since the last time File Download Counter was
  236. executed successfully.  It then searches the DIR files for a match.  Then
  237. FDC inserts the number of times <#> the file has been downloaded into the
  238. file description in the DIR file.  This will usually take up 4 or 5
  239. characters of the description.  If in doing so the description gets pushed
  240. too far to the right it will auto word wrap and create a new line, or add to
  241. the secondary line if it exists.  Therefore none of the file descriptions
  242. will be lost.  If desired, you can have FDC enter a separate line of text
  243. which indicates how many times the program has been downloaded.
  244.  
  245. Here is a sample of what FDC will do to the file descriptions in the DIR
  246. file.
  247.  
  248. Example of Style #1 and #2
  249. ──────────────────────────
  250. FILENAME.ARC   35252  06-27-90  <23> This is the description of the file.
  251. FILE-TWO.ZIP  213445  06-23-88  <11> This is another description.
  252. NEXTFILE.ZIP  243536  06-21-90  <14> This one has been downloaded 14 times,
  253.                               | and the description is auto word-wrapped.
  254. FILEFOUR.LZH  246246  05-12-90  <13> File Four v3.3, description.  With
  255.                               | this entry word wrapped, the "Uploaded by:"
  256.                               | line is not disturbed.
  257.                               | Uploaded by: Brandon Bachman
  258.  
  259. Example of Style #3
  260. ───────────────────
  261. FILENAME.ARC   35252  06-27-90  This is the description of the file.
  262.                               | Downloaded 23 times.
  263. FILE-TWO.ZIP  213445  06-23-88  This is another description.
  264.                               | Downloaded 12 times.
  265. NEXTFILE.ZIP  243536  06-21-90  This one has been downloaded 14 times,
  266.                               | and the description is auto word wrapped.
  267.                               | Downloaded 1234 times.
  268. FILEFOUR.LZH  246246  05-12-90  File Four v3.3, description.  With
  269.                               | this entry word wrapped, the "Uploaded by:"
  270.                               | Uploaded by: Brandon M. Bachman
  271.                               | Downloaded 233 times.
  272.  
  273.  
  274.  
  275. INSTALLATION                                                           2-2
  276. ──────────────────────────────────────────────────────────────────────────
  277. To install "File Download Counter" you must have the PKZip program
  278. available, then create a sub-directory for "File Download Counter" on your
  279. hard disk.  Enter the sub-directory and un-Zip the files.  Here is an
  280. example of how you might do this:
  281.  
  282.  
  283.            E:                     (Go to E: drive)
  284.            CD\                    (Go to the root directory)
  285.            MD FDC                 (Create E:\FDC sub-directory)
  286.            CD FDC                 (Go into the E:\FDC sub-directory)
  287.            COPY A:\FDC-310.ZIP    (Copy the program from drive A:)
  288.            PKUNZIP FDC-310.ZIP    (UnZip the program into the directory)
  289.  
  290.  
  291.  
  292. CONFIGURATION FILE                                                     2-3
  293. ──────────────────────────────────────────────────────────────────────────
  294. After you complete the installation you must then edit the FDC.CFG file
  295. included in this archive to your needs.  Read the  "Sample Configuration
  296. File" and "Operational Details" sections below for instructions.
  297.  
  298.  
  299.  
  300. STARTING NEW COUNT                                                     2-4
  301. ──────────────────────────────────────────────────────────────────────────
  302. First time users must initialize FDC by using the command line argument
  303. /START.  This will start the counters of FDC from the beginning of your
  304. DOWNLOAD.TXT file, thus counting all past downloads.
  305.  
  306. If you have been running FDC for a while but would like to restart the
  307. download count then run FDC with the /STRIP command line argument and
  308. the run it again with the /START argument.
  309.  
  310.  
  311.  
  312. STRIPPING FDC ENTRIES                                                  2-5
  313. ──────────────────────────────────────────────────────────────────────────
  314. If you would like to remove all entries made by FDC you may use the /STRIP
  315. command line argument to do so.  You will then need to run FDC with the
  316. /START command line argument to re-initialize FDC.  This is useful if you
  317. decide to switch from one style of editing your DIR files to another.
  318. (ie., STYLE=1 and you would like STYLE=3).
  319.  
  320.  
  321.  
  322. LOG FILE                                                               2-6
  323. ──────────────────────────────────────────────────────────────────────────
  324. If you would like record a log file of all FDC's activities use the
  325. argument LOG=filename in the FDC.CFG, where filename is the complete path
  326. and file name of the LOG file.  The format of the LOG file conforms to
  327. PCBoard's, so you can specify the LOG file as the CALLER log created by
  328. PCBoard if you wish.  Doing so will help cut down on many logs files
  329. clogging up your systems.
  330.  
  331.  
  332. WORD WRAPPING                                                          2-7
  333. ──────────────────────────────────────────────────────────────────────────
  334. FDC handles word wrapping in two ways.  If a file description requires
  335. word wrapping, FDC first searches for the "|" character in the secondary
  336. line of your file description, and when found will word wrap to the space
  337. following the "|" character.  However some sysops like to have all their
  338. secondary lines of the descriptions lined up on columns other than the
  339. default of the 32nd column by PCBoard.  You can change the default by
  340. using the argument CHAR=xx, where xx is the column or number of characters
  341. to word wrap to.
  342.  
  343. FDC will not disturb the "Uploaded by:" line when word wrapping.
  344.  
  345.  
  346.  
  347. THREE FORMATS FOR RECORDING DOWNLOAD COUNT!                            2-8
  348. ──────────────────────────────────────────────────────────────────────────
  349. FDC now supports three different formats for recording the number of times
  350. a file has been downloaded.  The first is the default which will put
  351. <##> in the first few characters of the first line of the files description
  352. in the DIR file.  The second will do the same as the first, however it will
  353. not word wrap but truncate all descriptions which exceed 79 characters.
  354. The third will insert a separate line at the end of the secondary lines of
  355. the description but before the "Uploaded by:"  This line will look like
  356. this:
  357.                    "| Downloaded 45 times."
  358.  
  359. If you perfer a differnet wording you may change the format to anyway
  360. you would like to editing the TEXT= parameter in the .CFG file.
  361.  
  362. By default FDC will insert this line starting at the 32nd column, however
  363. if you would like it to be inserted at another column simply use the
  364. CHAR=xx option specified section 2.9.
  365.  
  366. To implement one of the various format of recording the number of times
  367. downloaded use the STYLE=x option, where x is the number of the style you
  368. would like.
  369.  
  370.  
  371.  
  372. CONFIGURATION FILE                                                     4-1
  373. ──────────────────────────────────────────────────────────────────────────
  374. FDC daily operations are determined by the way you setup the FDC.CFG file.
  375. The configuration file must be called 'FDC.CFG' and be in the directory
  376. from which you run FDC.EXE.  It is critical that you take care in setting
  377. up this file, instructions for doing so are found in the "Sample
  378. Configuration File" section below and the above sections.
  379.  
  380. If you wish to have mulitple configuration files you may use the /CFG=
  381. command line argument.  If you wanted to use the configuration files
  382. NEWCFG.CFG and NEWCFG.DAT you would execute FDC with the command line
  383. "FDC /CFG=NEWCFG"  Note FDC will automatically apend the .CFG, .P and .S
  384. to the file names for the configuration file and data file names
  385. respectfully.
  386.  
  387.  
  388.  
  389. SAMPLE CONFIGURATION FILE                                              4-2
  390. ──────────────────────────────────────────────────────────────────────────
  391. Please refer to the SAMPLE.CFG file for a sample confgiuration file.
  392.  
  393. You may use any standard ASCII text editor to edit the SAMPLE.CFG file
  394. found in this archive, or to create your own.
  395.  
  396. Change the data in the SAMPLE.CFG to your needs and rename it FDC.CFG
  397.  
  398.  
  399.  
  400. OPERATIONAL DETAILS                                                    5-1
  401. ──────────────────────────────────────────────────────────────────────────
  402. After you have your FDC.CFG edited to your needs then type "FDC" and watch
  403. the wiz-bangs fly!  FDC will let you know if your FDC.CFG file may have
  404. errors.
  405.  
  406. NOTE: The first time you run the program it will NOT find any new files,
  407. because it will set the last run pointer to the last time you edited the
  408. FDC.CFG file.  If it is the first time you have run FDC use the /START
  409. switch to initialize FDC.  See "Starting New Count" above for more
  410. information on the /START command line argument.
  411.  
  412. To update your recent downloads every day, put FDC in your EVENT.SYS
  413. file, it will run smoothly in an event.  If there is an error, it will
  414. sound a beep, pause 10 seconds and then exit.
  415.  
  416.  
  417.  
  418. EXAMPLES OF COMMAND LINE ARGUMENTS TO RUN FDC, AND THE RESULTS         5-2
  419. ──────────────────────────────────────────────────────────────────────────
  420.  
  421.     1.  FDC
  422.  
  423.         This runs FDC at settings in the FDC.CFG file.
  424.  
  425.     2.  FDC /START
  426.  
  427.     This will run FDC and initialize the count from the beginning of
  428.     of the download.txt file.
  429.  
  430.     3.    FDC /STRIP
  431.  
  432.     This will run FDC and have it strip out all entries in your DIR
  433.     files that FDC made.  This is useful if you need to start the
  434.     the count over for FDC.
  435.  
  436.     4.  FDC /CFG=NEWCFG
  437.  
  438.         This will run FDC using the NEWCFG.CFG, and NEWCFG.T filenames
  439.         for the configuration file, and the data files respectfully.
  440.  
  441.  
  442.  
  443. COMMON QUESTIONS & ANSWERS                                             5-3
  444. ──────────────────────────────────────────────────────────────────────────
  445. Q.  I am a new user with File Download Counter and I it is not counting
  446.     my downloads.
  447.  
  448. A.  Make sure when you first run FDC to type "FDC /START" to initialize
  449.     the count in your DIR files.
  450.  
  451.  
  452. Q.  When I register FDC will I need to call your BBS to obtain future
  453.     registered updates, and will there be a fee for upgrading.
  454.  
  455. A.  FDC is self registering for all future versions, you can simply
  456.     download a copy from your favorite BBS.  There is and never will be
  457.     and additional fee for upgrading FDC even if prices do increase,
  458.     once you have are a registered user you may upgrade for free.
  459.  
  460.  
  461.  
  462. TECHNICAL SUPPORT                                                      6-1
  463. ──────────────────────────────────────────────────────────────────────────
  464. The latest version of "File Download Counter" software and technical
  465. support are available from:
  466.  
  467.   The Salt City Bulletin Board       Join the FDC Support (2) Conference
  468.   (801) 292-3308 (USR HST V.42Bis)   to download the newest versions, ask
  469.   PCRelay routable -> TERMINAL       questions, and offer suggestions.
  470.   FidoNet Node (1:311/7)
  471.  
  472. Or write to:  Brandon M. Bachman
  473.               1680 East 400 South Circle
  474.               Bountiful, Utah  84010
  475.  
  476.  
  477. OTHER PROGRAMS BY BRANDON M. BACHMAN                                   6-3
  478. ──────────────────────────────────────────────────────────────────────────
  479.  
  480.  
  481. What Happened Today v1.50
  482. ─────────────────────────
  483. Displays what happened in history on a given date (either system or
  484. manually set) date. Many display options!  Also creates BBS bulletins
  485. or news, and supports PCB 14.5+ @Xhh codes.  Five history databases
  486. available including: Sports, USA World, Science and Technology, Art,
  487. Entertainment and Media.  Many new dates added weekly.
  488.  
  489. Download as: WHT-150-ZIP  (Includes Sports History Library)
  490.  
  491.  
  492. Mail Time v2.00
  493. ───────────────
  494. Sysops utility that creates/updates bulletins and news on when the last
  495. echo mail run to the BBS occurred.  Supports all mail networks, and
  496. universal to all BBS software, although it will also support PCBoard
  497. 14.5+ @Xhh codes for color.  Many date and time format options.
  498. Includes PCBoard 14.5+ compatible log file output.
  499.  
  500. Download as: MT-200.ZIP
  501.  
  502.